<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<title>Rational (Metadata-Extractor - JavaDoc - An Open Source Java Library for Image File Metadata)</title>
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
    if (location.href.indexOf('is-external=true') == -1) {
        parent.document.title="Rational (Metadata-Extractor - JavaDoc - An Open Source Java Library for Image File Metadata)";
    }
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!--   -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Rational.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><em><a href='http://www.drewnoakes.com/code/exif/' title='Go to the project home page.'><img src='http://metadata-extractor.googlecode.com/git/Resources/metadata-extractor-logo-131x30.png' border=0 alt='Metadata Extractor Logo'></a></em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../com/drew/lang/RandomAccessFileReader.html" title="class in com.drew.lang"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../com/drew/lang/StringUtil.html" title="class in com.drew.lang"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/drew/lang/Rational.html" target="_top">Frames</a></li>
<li><a href="Rational.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!--   -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">com.drew.lang</div>
<h2 title="Class Rational" class="title">Class Rational</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>java.lang.Number</li>
<li>
<ul class="inheritance">
<li>com.drew.lang.Rational</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable</dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">Rational</span>
extends java.lang.Number
implements java.io.Serializable</pre>
<div class="block">Immutable class for holding a rational number without loss of precision.  Provides
 a familiar representation via toString() in form <code>numerator/denominator</code>.</div>
<dl><dt><span class="strong">Author:</span></dt>
  <dd>Drew Noakes http://drewnoakes.com</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../../serialized-form.html#com.drew.lang.Rational">Serialized Form</a></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!--   -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../com/drew/lang/Rational.html#Rational(long, long)">Rational</a></strong>(long&nbsp;numerator,
        long&nbsp;denominator)</code>
<div class="block">Creates a new instance of Rational.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!--   -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>byte</code></td>
<td class="colLast"><code><strong><a href="../../../com/drew/lang/Rational.html#byteValue()">byteValue</a></strong>()</code>
<div class="block">Returns the value of the specified number as a <code>byte</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><strong><a href="../../../com/drew/lang/Rational.html#doubleValue()">doubleValue</a></strong>()</code>
<div class="block">Returns the value of the specified number as a <code>double</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../com/drew/lang/Rational.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object&nbsp;obj)</code>
<div class="block">Compares two <code>Rational</code> instances, returning true if they are mathematically
 equivalent.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><strong><a href="../../../com/drew/lang/Rational.html#floatValue()">floatValue</a></strong>()</code>
<div class="block">Returns the value of the specified number as a <code>float</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a href="../../../com/drew/lang/Rational.html#getDenominator()">getDenominator</a></strong>()</code>
<div class="block">Returns the denominator.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a href="../../../com/drew/lang/Rational.html#getNumerator()">getNumerator</a></strong>()</code>
<div class="block">Returns the numerator.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../com/drew/lang/Rational.html" title="class in com.drew.lang">Rational</a></code></td>
<td class="colLast"><code><strong><a href="../../../com/drew/lang/Rational.html#getReciprocal()">getReciprocal</a></strong>()</code>
<div class="block">Returns the reciprocal value of this object as a new Rational.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../com/drew/lang/Rational.html" title="class in com.drew.lang">Rational</a></code></td>
<td class="colLast"><code><strong><a href="../../../com/drew/lang/Rational.html#getSimplifiedInstance()">getSimplifiedInstance</a></strong>()</code>
<div class="block">
 Simplifies the Rational number.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../com/drew/lang/Rational.html#hashCode()">hashCode</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../com/drew/lang/Rational.html#intValue()">intValue</a></strong>()</code>
<div class="block">Returns the value of the specified number as an <code>int</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../com/drew/lang/Rational.html#isInteger()">isInteger</a></strong>()</code>
<div class="block">Checks if this rational number is an Integer, either positive or negative.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a href="../../../com/drew/lang/Rational.html#longValue()">longValue</a></strong>()</code>
<div class="block">Returns the value of the specified number as a <code>long</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>short</code></td>
<td class="colLast"><code><strong><a href="../../../com/drew/lang/Rational.html#shortValue()">shortValue</a></strong>()</code>
<div class="block">Returns the value of the specified number as a <code>short</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../com/drew/lang/Rational.html#toSimpleString(boolean)">toSimpleString</a></strong>(boolean&nbsp;allowDecimal)</code>
<div class="block">Returns the simplest representation of this Rational's value possible.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../com/drew/lang/Rational.html#toString()">toString</a></strong>()</code>
<div class="block">Returns a string representation of the object of form <code>numerator/denominator</code>.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!--   -->
</a>
<h3>Constructor Detail</h3>
<a name="Rational(long, long)">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Rational</h4>
<pre>public&nbsp;Rational(long&nbsp;numerator,
        long&nbsp;denominator)</pre>
<div class="block">Creates a new instance of Rational.  Rational objects are immutable, so
 once you've set your numerator and denominator values here, you're stuck
 with them!</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="doubleValue()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>doubleValue</h4>
<pre>public&nbsp;double&nbsp;doubleValue()</pre>
<div class="block">Returns the value of the specified number as a <code>double</code>.
 This may involve rounding.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>doubleValue</code>&nbsp;in class&nbsp;<code>java.lang.Number</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the numeric value represented by this object after conversion
         to type <code>double</code>.</dd></dl>
</li>
</ul>
<a name="floatValue()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>floatValue</h4>
<pre>public&nbsp;float&nbsp;floatValue()</pre>
<div class="block">Returns the value of the specified number as a <code>float</code>.
 This may involve rounding.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>floatValue</code>&nbsp;in class&nbsp;<code>java.lang.Number</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the numeric value represented by this object after conversion
         to type <code>float</code>.</dd></dl>
</li>
</ul>
<a name="byteValue()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>byteValue</h4>
<pre>public final&nbsp;byte&nbsp;byteValue()</pre>
<div class="block">Returns the value of the specified number as a <code>byte</code>.
 This may involve rounding or truncation.  This implementation simply
 casts the result of <code>doubleValue()</code> to <code>byte</code>.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>byteValue</code>&nbsp;in class&nbsp;<code>java.lang.Number</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the numeric value represented by this object after conversion
         to type <code>byte</code>.</dd></dl>
</li>
</ul>
<a name="intValue()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>intValue</h4>
<pre>public final&nbsp;int&nbsp;intValue()</pre>
<div class="block">Returns the value of the specified number as an <code>int</code>.
 This may involve rounding or truncation.  This implementation simply
 casts the result of <code>doubleValue()</code> to <code>int</code>.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>intValue</code>&nbsp;in class&nbsp;<code>java.lang.Number</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the numeric value represented by this object after conversion
         to type <code>int</code>.</dd></dl>
</li>
</ul>
<a name="longValue()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>longValue</h4>
<pre>public final&nbsp;long&nbsp;longValue()</pre>
<div class="block">Returns the value of the specified number as a <code>long</code>.
 This may involve rounding or truncation.  This implementation simply
 casts the result of <code>doubleValue()</code> to <code>long</code>.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>longValue</code>&nbsp;in class&nbsp;<code>java.lang.Number</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the numeric value represented by this object after conversion
         to type <code>long</code>.</dd></dl>
</li>
</ul>
<a name="shortValue()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>shortValue</h4>
<pre>public final&nbsp;short&nbsp;shortValue()</pre>
<div class="block">Returns the value of the specified number as a <code>short</code>.
 This may involve rounding or truncation.  This implementation simply
 casts the result of <code>doubleValue()</code> to <code>short</code>.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>shortValue</code>&nbsp;in class&nbsp;<code>java.lang.Number</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the numeric value represented by this object after conversion
         to type <code>short</code>.</dd></dl>
</li>
</ul>
<a name="getDenominator()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDenominator</h4>
<pre>public final&nbsp;long&nbsp;getDenominator()</pre>
<div class="block">Returns the denominator.</div>
</li>
</ul>
<a name="getNumerator()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNumerator</h4>
<pre>public final&nbsp;long&nbsp;getNumerator()</pre>
<div class="block">Returns the numerator.</div>
</li>
</ul>
<a name="getReciprocal()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReciprocal</h4>
<pre>public&nbsp;<a href="../../../com/drew/lang/Rational.html" title="class in com.drew.lang">Rational</a>&nbsp;getReciprocal()</pre>
<div class="block">Returns the reciprocal value of this object as a new Rational.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the reciprocal in a new object</dd></dl>
</li>
</ul>
<a name="isInteger()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isInteger</h4>
<pre>public&nbsp;boolean&nbsp;isInteger()</pre>
<div class="block">Checks if this rational number is an Integer, either positive or negative.</div>
</li>
</ul>
<a name="toString()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;java.lang.String&nbsp;toString()</pre>
<div class="block">Returns a string representation of the object of form <code>numerator/denominator</code>.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>a string representation of the object.</dd></dl>
</li>
</ul>
<a name="toSimpleString(boolean)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toSimpleString</h4>
<pre>public&nbsp;java.lang.String&nbsp;toSimpleString(boolean&nbsp;allowDecimal)</pre>
<div class="block">Returns the simplest representation of this Rational's value possible.</div>
</li>
</ul>
<a name="equals(java.lang.Object)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre>public&nbsp;boolean&nbsp;equals(java.lang.Object&nbsp;obj)</pre>
<div class="block">Compares two <code>Rational</code> instances, returning true if they are mathematically
 equivalent.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>equals</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>obj</code> - the Rational to compare this instance to.</dd>
<dt><span class="strong">Returns:</span></dt><dd>true if instances are mathematically equivalent, otherwise false.  Will also
         return false if <code>obj</code> is not an instance of <code>Rational</code>.</dd></dl>
</li>
</ul>
<a name="hashCode()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hashCode</h4>
<pre>public&nbsp;int&nbsp;hashCode()</pre>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>hashCode</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a name="getSimplifiedInstance()">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getSimplifiedInstance</h4>
<pre>public&nbsp;<a href="../../../com/drew/lang/Rational.html" title="class in com.drew.lang">Rational</a>&nbsp;getSimplifiedInstance()</pre>
<div class="block"><p>
 Simplifies the Rational number.</p>
 <p>
 Prime number series: 1, 2, 3, 5, 7, 9, 11, 13, 17</p>
 <p>
 To reduce a rational, need to see if both numerator and denominator are divisible
 by a common factor.  Using the prime number series in ascending order guarantees
 the minimum number of checks required.</p>
 <p>
 However, generating the prime number series seems to be a hefty task.  Perhaps
 it's simpler to check if both d & n are divisible by all numbers from 2 ->
 (Math.min(denominator, numerator) / 2).  In doing this, one can check for 2
 and 5 once, then ignore all even numbers, and all numbers ending in 0 or 5.
 This leaves four numbers from every ten to check.</p>
 <p>
 Therefore, the max number of pairs of modulus divisions required will be:</p>
 <code><pre>
    4   Math.min(denominator, numerator) - 1
   -- * ------------------------------------ + 2
   10                    2
 <p/>
   Math.min(denominator, numerator) - 1
 = ------------------------------------ + 2
                  5
 </pre></code></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a simplified instance, or if the Rational could not be simplified,
         returns itself (unchanged)</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!--   -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Rational.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><em><a href='http://www.drewnoakes.com/code/exif/' title='Go to the project home page.'><img src='http://metadata-extractor.googlecode.com/git/Resources/metadata-extractor-logo-131x30.png' border=0 alt='Metadata Extractor Logo'></a></em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../com/drew/lang/RandomAccessFileReader.html" title="class in com.drew.lang"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../com/drew/lang/StringUtil.html" title="class in com.drew.lang"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/drew/lang/Rational.html" target="_top">Frames</a></li>
<li><a href="Rational.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small><i>Copyright &#169; 2003-2012 Drew Noakes. All Rights Reserved.</i>
<script src='http://www.google-analytics.com/urchin.js' type='text/javascript'></script>
<script type='text/javascript'>
_uacct = 'UA-936661-1';
urchinTracker();
</script></small></p>
</body>
</html>
